<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Index &mdash; bitstring documentation</title>
    <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '1.1',
        COLLAPSE_MODINDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="bitstring documentation" href="index.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="" title="General Index"
             accesskey="I">index</a></li>
        <li><a href="index.html">bitstring</a> &raquo;</li> 
      </ul>
    </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/bitstring_logo_small.png" alt="Logo"/>
            </a></p>

   

          <div id="searchbox" style="display: none">
            <h3>Quick search</h3>
              <form class="search" action="search.html" method="get">
                <input type="text" name="q" size="18" />
                <input type="submit" value="Go" />
                <input type="hidden" name="check_keywords" value="yes" />
                <input type="hidden" name="area" value="default" />
              </form>
              <p class="searchtip" style="font-size: 90%">
              Enter search terms or a module, class or function name.
              </p>
          </div>
          <script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            

   <h1 id="index">Index</h1>

   <a href="#_"><strong>_</strong></a> | <a href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#H"><strong>H</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#J"><strong>J</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#U"><strong>U</strong></a> 

   <hr />

   
<h2 id="_">_</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>

<dt><a href="reference.html#__contains__">__contains__() (built-in function)</a></dt>
<dt><a href="reference.html#__copy__">__copy__() (built-in function)</a></dt>
<dt><a href="reference.html#__delitem__">__delitem__() (built-in function)</a></dt>
<dt><a href="reference.html#__eq__">__eq__() (built-in function)</a></dt>
<dt><a href="reference.html#__getitem__">__getitem__() (built-in function)</a></dt>
<dt><a href="reference.html#__iadd__">__iadd__() (built-in function)</a></dt>
<dt><a href="reference.html#__ilshift__">__ilshift__() (built-in function)</a></dt>
<dt><a href="reference.html#__imul__">__imul__() (built-in function)</a></dt>
<dt><a href="reference.html#__init__">__init__() (built-in function)</a></dt>
<dt><a href="reference.html#__invert__">__invert__() (built-in function)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="reference.html#__irshift__">__irshift__() (built-in function)</a></dt>
<dt><a href="reference.html#__len__">__len__() (built-in function)</a></dt>
<dt><a href="reference.html#__lshift__">__lshift__() (built-in function)</a></dt>
<dt><a href="reference.html#__ne__">__ne__() (built-in function)</a></dt>
<dt><a href="reference.html#__repr__">__repr__() (built-in function)</a></dt>
<dt><a href="reference.html#__rshift__">__rshift__() (built-in function)</a></dt>
<dt><a href="reference.html#__setitem__">__setitem__() (built-in function)</a></dt>
<dt><a href="reference.html#__str__">__str__() (built-in function)</a></dt>
</dl></td></tr></table>

<h2 id="A">A</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>

<dt><a href="reference.html#advancebit">advancebit() (built-in function)</a></dt>
<dt><a href="reference.html#advancebits">advancebits() (built-in function)</a></dt>
<dt><a href="reference.html#advancebyte">advancebyte() (built-in function)</a></dt>
<dt><a href="reference.html#advancebytes">advancebytes() (built-in function)</a></dt>
<dt><a href="reference.html#allset">allset() (built-in function)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="reference.html#allunset">allunset() (built-in function)</a></dt>
<dt><a href="reference.html#anyset">anyset() (built-in function)</a></dt>
<dt><a href="reference.html#anyunset">anyunset() (built-in function)</a></dt>
<dt><a href="reference.html#append">append() (built-in function)</a></dt>
</dl></td></tr></table>

<h2 id="B">B</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>

<dt><a href="reference.html#bin">bin</a></dt>
<dt><a href="reference.html#BitString">BitString (built-in class)</a></dt>
<dt><a href="index.html#module-bitstring">bitstring (module)</a></dt>
<dt><a href="reference.html#bytealign">bytealign() (built-in function)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="reference.html#bytepos">bytepos</a></dt>
<dt><a href="reference.html#bytes">bytes</a></dt>
</dl></td></tr></table>

<h2 id="C">C</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>

<dt><a href="reference.html#cut">cut() (built-in function)</a></dt></dl></td><td width="33%" valign="top"><dl>
</dl></td></tr></table>

<h2 id="D">D</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>

<dt><a href="reference.html#delete">delete() (built-in function)</a></dt></dl></td><td width="33%" valign="top"><dl>
</dl></td></tr></table>

<h2 id="E">E</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>

<dt><a href="reference.html#endswith">endswith() (built-in function)</a></dt></dl></td><td width="33%" valign="top"><dl>
</dl></td></tr></table>

<h2 id="F">F</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>

<dt><a href="reference.html#find">find() (built-in function)</a></dt>
<dt><a href="reference.html#findall">findall() (built-in function)</a></dt>
<dt><a href="reference.html#floatle">floatle</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="reference.html#floatne">floatne</a></dt>
</dl></td></tr></table>

<h2 id="H">H</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>

<dt><a href="reference.html#hex">hex</a></dt></dl></td><td width="33%" valign="top"><dl>
</dl></td></tr></table>

<h2 id="I">I</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>

<dt><a href="reference.html#insert">insert() (built-in function)</a></dt>
<dt><a href="reference.html#int">int</a></dt>
<dt><a href="reference.html#intbe">intbe</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="reference.html#intle">intle</a></dt>
<dt><a href="reference.html#intne">intne</a></dt>
</dl></td></tr></table>

<h2 id="J">J</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>

<dt><a href="reference.html#join">join() (built-in function)</a></dt></dl></td><td width="33%" valign="top"><dl>
</dl></td></tr></table>

<h2 id="O">O</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>

<dt><a href="reference.html#oct">oct</a></dt>
<dt><a href="reference.html#overwrite">overwrite() (built-in function)</a></dt></dl></td><td width="33%" valign="top"><dl>
</dl></td></tr></table>

<h2 id="P">P</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>

<dt><a href="reference.html#pack">pack() (built-in function)</a></dt>
<dt><a href="reference.html#peek">peek() (built-in function)</a></dt>
<dt><a href="reference.html#peekbit">peekbit() (built-in function)</a></dt>
<dt><a href="reference.html#peekbitlist">peekbitlist() (built-in function)</a></dt>
<dt><a href="reference.html#peekbits">peekbits() (built-in function)</a></dt>
<dt><a href="reference.html#peekbyte">peekbyte() (built-in function)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="reference.html#peekbytelist">peekbytelist() (built-in function)</a></dt>
<dt><a href="reference.html#peekbytes">peekbytes() (built-in function)</a></dt>
<dt><a href="reference.html#peeklist">peeklist() (built-in function)</a></dt>
<dt><a href="reference.html#prepend">prepend() (built-in function)</a></dt>
</dl></td></tr></table>

<h2 id="R">R</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>

<dt><a href="reference.html#read">read() (built-in function)</a></dt>
<dt><a href="reference.html#readbit">readbit() (built-in function)</a></dt>
<dt><a href="reference.html#readbitlist">readbitlist() (built-in function)</a></dt>
<dt><a href="reference.html#readbits">readbits() (built-in function)</a></dt>
<dt><a href="reference.html#readbyte">readbyte() (built-in function)</a></dt>
<dt><a href="reference.html#readbytelist">readbytelist() (built-in function)</a></dt>
<dt><a href="reference.html#readbytes">readbytes() (built-in function)</a></dt>
<dt><a href="reference.html#readlist">readlist() (built-in function)</a></dt>
<dt><a href="reference.html#replace">replace() (built-in function)</a></dt>
<dt><a href="reference.html#retreatbit">retreatbit() (built-in function)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="reference.html#retreatbits">retreatbits() (built-in function)</a></dt>
<dt><a href="reference.html#retreatbyte">retreatbyte() (built-in function)</a></dt>
<dt><a href="reference.html#retreatbytes">retreatbytes() (built-in function)</a></dt>
<dt><a href="reference.html#reverse">reverse() (built-in function)</a></dt>
<dt><a href="reference.html#reversebytes">reversebytes() (built-in function)</a></dt>
<dt><a href="reference.html#rfind">rfind() (built-in function)</a></dt>
<dt><a href="reference.html#rol">rol() (built-in function)</a></dt>
<dt><a href="reference.html#ror">ror() (built-in function)</a></dt>
</dl></td></tr></table>

<h2 id="S">S</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>

<dt><a href="reference.html#se">se</a></dt>
<dt><a href="reference.html#seek">seek() (built-in function)</a></dt>
<dt><a href="reference.html#seekbyte">seekbyte() (built-in function)</a></dt>
<dt><a href="reference.html#set">set() (built-in function)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="reference.html#slice">slice() (built-in function)</a></dt>
<dt><a href="reference.html#split">split() (built-in function)</a></dt>
<dt><a href="reference.html#startswith">startswith() (built-in function)</a></dt>
</dl></td></tr></table>

<h2 id="T">T</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>

<dt><a href="reference.html#tell">tell() (built-in function)</a></dt>
<dt><a href="reference.html#tellbyte">tellbyte() (built-in function)</a></dt>
<dt><a href="reference.html#tobytes">tobytes() (built-in function)</a></dt>
<dt><a href="reference.html#tofile">tofile() (built-in function)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="reference.html#truncateend">truncateend() (built-in function)</a></dt>
<dt><a href="reference.html#truncatestart">truncatestart() (built-in function)</a></dt>
</dl></td></tr></table>

<h2 id="U">U</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>

<dt><a href="reference.html#ue">ue</a></dt>
<dt><a href="reference.html#uint">uint</a></dt>
<dt><a href="reference.html#uintbe">uintbe</a></dt>
<dt><a href="reference.html#uintle">uintle</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="reference.html#uintne">uintne</a></dt>
<dt><a href="reference.html#unpack">unpack() (built-in function)</a></dt>
<dt><a href="reference.html#unset">unset() (built-in function)</a></dt>
</dl></td></tr></table>



          </div>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="" title="General Index"
             >index</a></li>
        <li><a href="index.html">bitstring</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
      &copy; Copyright 2009, Scott Griffiths.
    </div>
  </body>
</html>